home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / audio / alGetWidth.z / alGetWidth
Encoding:
Text File  |  2002-10-03  |  6.0 KB  |  133 lines
  1.  
  2.  
  3.  
  4. aaaallllGGGGeeeettttWWWWiiiiddddtttthhhh((((3333ddddmmmm))))                                                aaaallllGGGGeeeettttWWWWiiiiddddtttthhhh((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      alSetWidth, alGetWidth - get/set the wordsize for integer audio data
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////aaaauuuuddddiiiioooo....hhhh>>>>
  13.  
  14.      iiiinnnntttt aaaallllGGGGeeeettttWWWWiiiiddddtttthhhh((((AAAALLLLccccoooonnnnffffiiiigggg ccccoooonnnnffffiiiigggg))))
  15.  
  16.      iiiinnnntttt aaaallllSSSSeeeettttWWWWiiiiddddtttthhhh((((AAAALLLLccccoooonnnnffffiiiigggg ccccoooonnnnffffiiiigggg,,,, iiiinnnntttt ssssaaaammmmpppplllleeeessssiiiizzzzeeee))))
  17.  
  18. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR
  19.      _c_o_n_f_i_g       expects an AAAALLLLccccoooonnnnffffiiiigggg structure, the returned value of a call
  20.                   to aaaallllNNNNeeeewwwwCCCCoooonnnnffffiiiigggg((((3333ddddmmmm)))) or aaaallllGGGGeeeettttCCCCoooonnnnffffiiiigggg((((3333ddddmmmm)))).
  21.  
  22.      _s_a_m_p_l_e_s_i_z_e   expects a symbolic constant that identifies the size of an
  23.                   integer audio sample.  There are three symbolic constants
  24.                   defined for this parameter.
  25.  
  26.                   AAAALLLL____SSSSAAAAMMMMPPPPLLLLEEEE____8888 indicates a one byte (signed char) sample width
  27.                   in the range -128 to 127.
  28.  
  29.                   AAAALLLL____SSSSAAAAMMMMPPPPLLLLEEEE____11116666 indicates a 16-bit (short) sample width in the
  30.                   range -32768 to 32767.
  31.  
  32.                   AAAALLLL____SSSSAAAAMMMMPPPPLLLLEEEE____22224444 indicates a 32-bit (int) sample width in the
  33.                   range -8388608 to 8388607. Note that though a 32-bit integer
  34.                   is used for ease of packing, the audio system will limit
  35.                   values to 24 bits; hence the name AL_SAMPLE_24.
  36.  
  37. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  38.      aaaallllGGGGeeeettttWWWWiiiiddddtttthhhh returns the current sample width setting in the AAAALLLLccccoooonnnnffffiiiigggg
  39.      structure _c_o_n_f_i_g.
  40.  
  41.      aaaallllSSSSeeeettttWWWWiiiiddddtttthhhh sets the sample width setting in the AAAALLLLccccoooonnnnffffiiiigggg structure
  42.      _c_o_n_f_i_g.  Any audio port that you then configure using _c_o_n_f_i_g will have
  43.      the audio sample size you specify with _s_a_m_p_l_e_s_i_z_e.
  44.  
  45.      Both aaaallllGGGGeeeettttWWWWiiiiddddtttthhhh and aaaallllSSSSeeeettttWWWWiiiiddddtttthhhh are only meaningful if you are using an
  46.      integer sample format (the default). If you are using a floating point
  47.      format (see aaaallllSSSSeeeettttSSSSaaaammmmppppFFFFmmmmtttt((((3333ddddmmmm))))), the wordsize is implicit in the selected
  48.      format; calls to aaaallllSSSSeeeettttWWWWiiiiddddtttthhhh will not affect the behavior of
  49.      aaaallllRRRReeeeaaaaddddFFFFrrrraaaammmmeeeessss((((3333ddddmmmm)))) or aaaallllWWWWrrrriiiitttteeeeFFFFrrrraaaammmmeeeessss((((3333ddddmmmm)))) until you switch to an integer
  50.      sample format.
  51.  
  52. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  53.      Upon successful completion aaaallllGGGGeeeettttWWWWiiiiddddtttthhhh returns a int whose value is one of
  54.      the symbolic constants described above for _s_a_m_p_l_e_s_i_z_e. Otherwise,
  55.      aaaallllGGGGeeeettttWWWWiiiiddddtttthhhh returns -1 and and sets an error number. This error number can
  56.      be retrieved with oooosssseeeerrrrrrrroooorrrr((((3333CCCC)))).
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. aaaallllGGGGeeeettttWWWWiiiiddddtttthhhh((((3333ddddmmmm))))                                                aaaallllGGGGeeeettttWWWWiiiiddddtttthhhh((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      aaaallllGGGGeeeettttWWWWiiiiddddtttthhhh can fail for the following reason:
  75.  
  76.      AAAALLLL____BBBBAAAADDDD____CCCCOOOONNNNFFFFIIIIGGGG    _c_o_n_f_i_g is invalid or null.
  77.  
  78.      aaaallllSSSSeeeettttWWWWiiiiddddtttthhhh returns 0 if successful. Otherwise, it returns -1 and sets an
  79.      error number which can be retrieved with _o_s_e_r_r_o_r(_3_C).
  80.  
  81.      aaaallllSSSSeeeettttWWWWiiiiddddtttthhhh can fail for the following reasons:
  82.  
  83.      AAAALLLL____BBBBAAAADDDD____CCCCOOOONNNNFFFFIIIIGGGG   _c_o_n_f_i_g is invalid or null.
  84.  
  85.      AAAALLLL____BBBBAAAADDDD____WWWWIIIIDDDDTTTTHHHH    _w_i_d_t_h is not one of the valid constants listed above.
  86.  
  87. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  88.      alNewConfig(3dm), alGetConfig(3dm), alOpenPort(3dm), alSetConfig(3dm),
  89.      oserror(3C)
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.